cauchy_neighborhood_function Derived Type

type, public, extends(neighborhood_function_base) :: cauchy_neighborhood_function

Class that implements the Cauchy Neighborhood Function


Inherits

type~~cauchy_neighborhood_function~~InheritsGraph type~cauchy_neighborhood_function cauchy_neighborhood_function type~neighborhood_function_base neighborhood_function_base type~cauchy_neighborhood_function->type~neighborhood_function_base

Type-Bound Procedures

procedure, public :: create => create_cauchy_neighborhood

  • private subroutine create_cauchy_neighborhood(my_neigh_fn, parameters)

    Class Constructor

    Arguments

    Type IntentOptional Attributes Name
    class(cauchy_neighborhood_function) :: my_neigh_fn

    A cauchy_neighborhood_function object
    real(kind=wp), intent(in), dimension(:) :: parameters

    A real array with the paramters sigma and p

procedure, public :: calculate => calculate_cauchy_neighborhood

  • private function calculate_cauchy_neighborhood(my_neigh_fn, geometric_distance) result(n)

    Function to calculate the value of the cauchy neighborhood

    Arguments

    Type IntentOptional Attributes Name
    class(cauchy_neighborhood_function) :: my_neigh_fn

    A cauchy_neighborhood_function object
    real(kind=wp), intent(inout) :: geometric_distance

    A real variable with the geometric distnace

    Return Value real(kind=wp)

    A real value

Source Code

    type,extends(neighborhood_function_base) :: cauchy_neighborhood_function
    !! Class that implements the Cauchy Neighborhood Function
        private
            real(kind=wp) :: sigma,p
        contains
            procedure,public :: create => create_cauchy_neighborhood
            procedure,public :: calculate => calculate_cauchy_neighborhood
    end type cauchy_neighborhood_function